/*
 * Flashlib - QB9 common Flash library
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


package com.qb9.flashlib.fsm
{
	import com.qb9.flashlib.tasks.*;
	import flash.events.*;
	
	/**
	 * Interface for all states registered to a FSM.
	 */
	public interface IState extends ITask, ITransitionBuilder
	{
		/** Unique id. */
		function get name():String;
		/** @private */
		function set name(n:String):void;
		
		/**
		 * Enter the state. This method is called automatically for FSM substates.
		 *
		 * @param data Generic data passed to the state.  If the event transition is caused
		 *             by a QEvent instance, its <code>data</code> attribute is passed to this method.
		 */
		function enter(data:* = null):void;
		
		/**
		 * Exit the state. This method is called automatically for FSM substates.
		 *
		 * @param data Generic data passed to the state.  If the event transition is caused
		 *             by a QEvent instance, its <code>data</code> attribute is passed to this method.
		 */
		function exit(data:* = null):void;
	}
}
